home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Gold Collection / Software Vault - The Gold Collection (American Databankers) (1993).ISO / cdr41 / mshell10.zip / MSHELL10.DOC < prev    next >
Text File  |  1993-04-13  |  17KB  |  346 lines
  1.                                                                    │
  2.                                                                    │
  3.                                                                    │
  4.                                                                    │O
  5.                                                                    │B
  6.                                                                    │S
  7.                                                                    │I
  8.                                                                    │D
  9.                                                                    │I
  10.                                                                    │A
  11.                                                                    │N
  12.                                                                    │
  13.                                                                    │
  14.                                                                    │S
  15.                                                                    │O
  16.                                                                    │F
  17.                                                                    │T
  18.                                                                    │W
  19.                              Mod Shell                             │A
  20.                                                                    │R
  21.                             Version 1.0                            │E
  22.                                                                    │
  23.                           Obsidian Software                        │
  24.                              March, 1992                           │
  25.                                                                    │
  26.                                                                    │
  27.            Copyright 1992, Edmund Taylor and Peter Taylor          │
  28.                                                                    │
  29.                                                                    │
  30.                                                                    │
  31.                                                                    │
  32.                                                                    │
  33.                                                                    │
  34.                                                                    │
  35.                                                                    │
  36.                                                                    │
  37.                                                                    │
  38.                                                                    │
  39.                                                                    │
  40.                                                                    │
  41.                                                                    │
  42.                                                                    │
  43.                                                                    │
  44.                                                                    │
  45.                                                                    │
  46.                                                                    │
  47.                                                                    │
  48.                                                                    │
  49.                                                                    │
  50.                                                                    │
  51.                                                                    │
  52.                                                                    │   
  53.                                                                    │    
  54.                                                                    │     
  55.                                                                    │   
  56.                                                                    │
  57.                                                                    │
  58.                                                                    │
  59.                                                                    │
  60.                                                                    │
  61.  
  62. Mod Shell 1.0                                        Introduction - 1
  63.  
  64. Introduction - What is MOD SHELL?
  65. ~~~~~~~~~~~~
  66.  
  67.      Mod Shell is a menu program for playing Amiga Mod files.  Although
  68. there are many front-ends for Mod players already out, Mod Shell does have 
  69. its advantages. Mod Shell, like its counterparts, can play Mods out of 
  70. archives, but it can't play multiple Mods per archive. For example, one can't 
  71. zip up all their Mods into one file.  A separate .zip file for each Mod is 
  72. needed.  The reason for this is speed.  When there are 500 Mods it takes 
  73. forever to look through each .zip for the Mods they contain, as other programs 
  74. do. Therefore Mod Shell is faster. It just searches through the directory for 
  75. every file that matches the specified extensions - i.e. NST, ZIP, LZH etc. 
  76. then loads it into the list.  Mod Shell can use Extended and Expanded memory, 
  77. to give more conventional memory to the Mod player. This program has 
  78. flexibility by allowing up to five different compression programs.  Also, 
  79. though the name of the program is Mod Shell, it can be configured to play 
  80. almost anything.
  81.  
  82.  
  83. Disclaimer
  84. ~~~~~~~~~~
  85. This program is provided "AS IS" and it is without warranty.  No 
  86. liability shall be assumed for direct or consequential damage caused 
  87. by the use of this software.  The only claim that is made is that 
  88. there are no intentional bugs or fatal errors in any original copy of 
  89. the program that you receive directly from the authors.
  90.  
  91.  
  92. Requirements
  93. ~~~~~~~~~~~~
  94.  
  95.      This program has been tested with MS-DOS 5.0 on a 286/8 - 486/33.  Mod
  96. Shell will take advantage of Extended and Expanded memory if available.  A
  97. hard drive is strongly recommended.  Also SORT.EXE, supplied with dos, is
  98. needed for a sorted list of files.   Another command-line sorting program
  99. may suffice.  See 'Configuring Mod Shell' for more details.  Also, for the 
  100. ability to play compressed Mods, obviously the program to decompress them is 
  101. needed.  This program can support a Microsoft compatible mouse.
  102.  
  103. *NOTE* Mod Shell was not tested with a monochrome display, so we recommend
  104.        the use of color graphics--but feel free to test this program with
  105.        monochrome.
  106.  
  107. Mod Shell 1.0                                Configuring Mod Shell - 2
  108.  
  109. Configuring Mod Shell
  110. ~~~~~~~~~~~~~~~~~~~~~
  111.  
  112.      Mod Shell uses 'cloning' techniques.  All the configuration information 
  113. is stored in MODSHELL.EXE.  Therefore we are including the program 
  114. MSCONFIG.EXE.  
  115.  
  116. Usage : MSCONFIG <filename (optional)>
  117.  
  118.         <filename> is the optional command-line parameter to the .EXE file
  119.         to be configured.  Default is 'MODSHELL.EXE'.  
  120.  
  121.   ╒═══════════════════════ Mod Shell Configuration ════════════════════════╕
  122.   │                                                                        │
  123.   │     Mod Player TRAK                                                    │
  124.   │ Temp Directory MSHELL!!                                                │
  125.   │  Mod Directory C:\TRAK\MODS                                            │
  126.   │   Sort Program SORT.EXE                                                │
  127.   │   Window Delay 2000                                                    │
  128.   │  Max # of Mods 1000000                                                 │
  129.   │    Mouse [Y/N] Y                                                       │
  130.   │    Sort  [Y/N] Y                                                       │
  131.   │                                                                        │
  132.   │     1) Mod Ext MOD    1) ARC Ext ZIP  Program PKUNZIP                  │
  133.   │     2) Mod Ext NST    2) ARC Ext ARJ  Program ARJ E                    │
  134.   │     3) Mod Ext        3) ARC Ext LZH  Program LHARC X                  │
  135.   │     4) Mod Ext        4) ARC Ext      Program                          │
  136.   │     5) Mod Ext        5) ARC Ext      Program                          │
  137.   │                                                                        │
  138.   │  MOD Player, full path and program name.  {Help line}                  │
  139.   ╘════════════════════════════════════════════════════════════════════════╛
  140.                ( Sample entry screen from MSCONFIG.EXE )
  141.  
  142.  
  143. TAB or the arrow keys change the current editing field.  When ESCAPE is
  144. pressed MSCONFIG will ask to save the configuration, answering no will 
  145. quit the program without saving anything.  When changing the information 
  146. be sure to press ENTER when done editing each field.  
  147.  
  148.       Mod Player - This is the full path and filename of the program you
  149.                    want Mod Shell to play the files with.  
  150.  
  151.   Temp Directory - Used internally by Mod Shell.  The .MOD being played will
  152.                    be copied there temporarily.  We recommend not changing it.
  153.  
  154.    Mod Directory - This is the full path and directory name to where the Mod
  155.                    files are kept.
  156.  
  157.     Sort Program - This is the program used to sort the Mod listing.  Mod
  158.                    Shell passes '< SORTMA$$.TMP > SORTMA$$.NEW' to this
  159.                    sort program.  SORTMA$$.TMP is the text file containing
  160.                    the unsorted list, and SORTMA$$.NEW is the new sorted
  161.                    listing to create.  You can create a batch file to sort
  162.                    the listing if your sort program doesn't support these
  163.                    parameters.  Simply let %2 and %4 represent SORTMA$$.TMP
  164.                    and SORTMA$$.NEW respectively.
  165.  
  166. Mod Shell 1.0                                Configuring Mod Shell - 3
  167.  
  168.  
  169.     Window Delay - When Mod Shell plays a Mod a window is displayed, mainly
  170.                    for the purpose of allowing the user to abort playing
  171.                    multiple Mods and toggling other features.  Window Delay
  172.                    is the length of time this window is displayed in milli-
  173.                    seconds.  If this is set to 0 the window will not be
  174.                    displayed, and the abort and other features will not be
  175.                    available.
  176.  
  177.    Max # of Mods - This was mainly for our programming use.  It specifies
  178.                    the maximum number of Mods that Mod Shell can handle.
  179.                    We have the default set to a million which is the
  180.                    maximum value.
  181.  
  182.      Mouse [Y/N] - This field specifies whether or not to enable the mouse
  183.                    in Mod Shell.  If there is no mouse installed and this 
  184.                    is set to Y, don't worry, Mod Shell automatically
  185.                    detects the presence of a mouse.
  186.  
  187.       Sort [Y/N] - This is to turn sorting on/off.  If this is set to
  188.                    Y, SORT.EXE or your specified sort program must
  189.                    be in the path or current directory.  We included
  190.                    this in the configuration because sorting slows
  191.                    down the loading of Mod Shell.  A fast alternative to
  192.                    this sorting method is actually sorting the Mod
  193.                    directory and setting this to N.
  194.  
  195.    (1-5) Mod Ext - When Mod Shell reads the files from the Mod directory,
  196.                    it will look for files with these specified extensions.
  197.                    This is for the Mod files that have different extensions
  198.                    such as NST, SD4 and SD2, etc.
  199.  
  200.    (1-5) Arc Ext - These are the extensions of the compressed files that
  201.                    Mod Shell should recognize and work with.
  202.  
  203.          Program - This field is directly associated with Arc Ext.  Program
  204.                    is the compression program for decompressing the files
  205.                    with the extension specified in its corresponding Arc
  206.                    Ext field.  
  207.                    
  208.        Help Line - This displays a simple help line for each input field.
  209.  
  210.  
  211. *NOTE*  It is possible to use .BAT files in the program fields, therefore 
  212.         Mod players with different command-line parameters are supported.  
  213.         A sample .BAT file is included.
  214.                                    
  215.  
  216. Mod Shell 1.0                                      Using Mod Shell - 4
  217.  
  218.  
  219. Using Mod Shell
  220. ~~~~~~~~~~~~~~~
  221.  
  222.      Mod Shell is very easy to use, and has mouse support.  All of the Mod
  223. names will appear in the list in yellow, if they aren't compressed they will
  224. appear in white.  Here are the keyboard commands for the main program, and 
  225. the equivalent mouse commands:
  226.  
  227.                                   "A" - "Z"
  228.      When any of the alpha characters are pressed, the highlight bar is 
  229.      moved to the first file beginning with the letter corresponding with 
  230.      the key.  There is no equivalent mouse command.
  231.  
  232.                           ENTER or BOTH MOUSE BUTTONS
  233.     Plays all tagged files, or plays currently highlighted file if none are 
  234.     tagged.
  235.                          
  236.                          ESCAPE or RIGHT MOUSE BUTTON
  237.                               Quits program.
  238.      
  239.                         SPACEBAR or LEFT MOUSE BUTTON
  240.     Tags file. *NOTE*  When mouse support is active, the left button 
  241.     highlights the file--it must then be pressed again to tag it.
  242.  
  243.                                      TAB
  244.     Tags all files (if none have been tagged yet), or untags all tagged files.  
  245.     There is no equivalent mouse command.
  246.  
  247.                        *** NOTE ON THE FOLLOWING ***
  248.        Using the mouse,  clicking on the arrow characters to the right of 
  249.        the window achieves the same effect of Page Up and Page Down.  Also
  250.        clicking anywhere  on the slide bar shifts  the window's contents.
  251.     
  252.                              PAGE UP and PAGE DOWN
  253.                  Shift's window's contents up or down a page.
  254.                            
  255.                             UP ARROW and DOWN ARROW
  256.                 The arrow keys move the highlight up or down.
  257.  
  258.                                  HOME and END
  259.     Shift's window's contents to the beginning or end of the list.
  260.  
  261. When enter is pressed, a window like this is displayed (if window delay
  262. is not set to 0) :
  263.               ╒═══════════════ Mod Shell ═══════════════╕
  264.               │                                         │
  265.               │ Playing:  ROCKIT                        │
  266.               │                                         │
  267.               │ ESC - Stop  S - Skip  R - Repeat: OFF   │
  268.               ╘═════════════════════════════════════════╛
  269.                             ( Delay Window )
  270.  
  271.  
  272.  
  273. Mod Shell 1.0                                      Using Mod Shell - 5
  274.  
  275. The keyboard options here are as follows:
  276.      
  277.                                     ESCAPE
  278.                       Quits back to the main program.
  279.  
  280.                                      "S"
  281.     Skips the current Mod, and goes to the next tagged one (if selected).
  282.                                       
  283.                                      "R"
  284.     Toggles the Repeat flag.  If it is on, it will continuously play the 
  285.     currently selected Mod(s).
  286.      
  287.                                      "P"
  288.     This option will pause the window until a key is pressed.
  289.  
  290.  
  291. Command-line Options
  292. ~~~~~~~~~~~~~~~~~~~~
  293.  
  294.      We have provided the following commandline options to allow one to
  295. change the configuration temporarily for Mod Shell, without having to enter 
  296. MSCONFIG.EXE.
  297.  
  298.        /M             - Enable mouse support.
  299.  
  300.        /R             - Force the Repeat Flag on.
  301.  
  302.        /MP=[PROGRAM]  - Set the Mod player.  Substitute [PROGRAM] with
  303.                         the full path and filename of the Mod player.
  304.  
  305.        /MD=[DIR]      - Set the Mod directory.  Replace [DIR] with the
  306.                         full path to the directory where Mods are located.
  307.  
  308.        /WD=[TIME]     - Sets the delay for the Pause Windows.  Replace
  309.                         [TIME] with the length in milliseconds.
  310.  
  311.        /S=[Y/N]       - Indicate whether or not to sort Mod listing.
  312.                         Replace [Y/N] with either 'Y' to sort, or 'N'
  313.                         not to.
  314.  
  315. EXAMPLE:
  316.  
  317.      MODSHELL /R /MP=C:\MOD\TRAK.EXE /MD=C:\DOWNLOAD\ /WD=3000 /S=N
  318.  
  319. Mod Shell 1.0                                             Revision - 6
  320.  
  321. Revision History
  322. ~~~~~~~~~~~~~~~~
  323. March 1992 -
  324.     First release!  Mod Shell 1.0
  325.     
  326.     Special thanks to David Kammeyer for his help and very good suggestions 
  327.     on future versions of Mod Shell.
  328.  
  329.  
  330. Registration
  331. ~~~~~~~~~~~~
  332.  
  333.      If you like this program and use it regularly, please register it.
  334. By doing so you'll support the future development of Mod Shell and other
  335. programs from Obsidian Software.  When you register you'll receive, in the
  336. mail, a registered copy of Mod Shell.  If an update is released we'll
  337. send it to you free!  See REGISTER.FRM for more details on registration.  
  338.  
  339. Please feel free to send us your questions or comments, even if you're not
  340. registering.  We'd really appreciate your help in improving Mod Shell.
  341.  
  342.               Send your letters to :  Obsidian Software
  343.                                       1021 S. Euclid
  344.                                       Oak Park, IL 60304
  345.  
  346.